<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8">
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        
        
        <link rel="canonical" href="https://www.angular-gantt.com/plugins/groups/">
        <link rel="shortcut icon" href="../../img/favicon.ico">

        <title>Groups - angular-gantt</title>

        <link href="../../css/bootstrap-custom.min.css" rel="stylesheet">
        <link href="../../css/font-awesome-4.0.3.css" rel="stylesheet">
        <link href="../../css/prettify-1.0.css" rel="stylesheet">
        <link href="../../css/base.css" rel="stylesheet">

        <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
        <!--[if lt IE 9]>
            <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
            <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
        <![endif]-->
    </head>

    <body>

        <div class="navbar navbar-default navbar-fixed-top" role="navigation">
    <div class="container">

        <!-- Collapsed navigation -->
        <div class="navbar-header">
            <!-- Expander button -->
            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
            </button>

            <!-- Main title -->
            <a class="navbar-brand" href="../..">angular-gantt</a>
        </div>

        <!-- Expanded navigation -->
        <div class="navbar-collapse collapse">
            <!-- Main navigation -->
            <ul class="nav navbar-nav">
            
            
                <li >
                    <a href="../../get-started">Get Started</a>
                </li>
            
            
            
                <li class="dropdown">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Configuration <b class="caret"></b></a>
                    <ul class="dropdown-menu">
                    
                        <li >
                            <a href="../../configuration/data">Data</a>
                        </li>
                    
                        <li >
                            <a href="../../configuration/timespans">Timespans</a>
                        </li>
                    
                        <li >
                            <a href="../../configuration/attributes">Attributes</a>
                        </li>
                    
                        <li >
                            <a href="../../configuration/plugins">Plugins</a>
                        </li>
                    
                        <li >
                            <a href="../../configuration/customize">Customize</a>
                        </li>
                    
                        <li >
                            <a href="../../configuration/api">API</a>
                        </li>
                    
                        <li >
                            <a href="../../configuration/write_plugin">Write a Plugin</a>
                        </li>
                    
                    </ul>
                </li>
            
            
            
                <li class="dropdown active">
                    <a href="#" class="dropdown-toggle" data-toggle="dropdown">Plugins <b class="caret"></b></a>
                    <ul class="dropdown-menu">
                    
                        <li >
                            <a href="../labels">Labels</a>
                        </li>
                    
                        <li >
                            <a href="../table">Table</a>
                        </li>
                    
                        <li >
                            <a href="../tree">Tree</a>
                        </li>
                    
                        <li >
                            <a href="../corner">Corner</a>
                        </li>
                    
                        <li class="active">
                            <a href=".">Groups</a>
                        </li>
                    
                        <li >
                            <a href="../dependencies">Dependencies</a>
                        </li>
                    
                        <li >
                            <a href="../sortable">Sortable</a>
                        </li>
                    
                        <li >
                            <a href="../movable">Movable</a>
                        </li>
                    
                        <li >
                            <a href="../drawtask">Draw Task</a>
                        </li>
                    
                        <li >
                            <a href="../tooltips">Tooltips</a>
                        </li>
                    
                        <li >
                            <a href="../bounds">Bounds</a>
                        </li>
                    
                        <li >
                            <a href="../sections">Sections</a>
                        </li>
                    
                        <li >
                            <a href="../progress">Progress</a>
                        </li>
                    
                        <li >
                            <a href="../overlap">Overlap</a>
                        </li>
                    
                        <li >
                            <a href="../resizeSensor">Resize Sensor</a>
                        </li>
                    
                    </ul>
                </li>
            
            
            
                <li >
                    <a href="../../sources">Sources</a>
                </li>
            
            
            
                <li >
                    <a href="../../contribute">Contribute</a>
                </li>
            
            
            
                <li >
                    <a href="../../faq">FAQ</a>
                </li>
            
            
            
                <li >
                    <a href="../../about">About</a>
                </li>
            
            
            </ul>

            <!-- Search, Navigation and Repo links -->
            <ul class="nav navbar-nav navbar-right">
                
                <li >
                    <a rel="next" href="../corner">
                        <i class="fa fa-arrow-left"></i> Previous
                    </a>
                </li>
                <li >
                    <a rel="prev" href="../dependencies">
                        Next <i class="fa fa-arrow-right"></i>
                    </a>
                </li>
                
                <li>
                    <a href="https://github.com/angular-gantt/angular-gantt">
                        
                            <i class="fa fa-github"></i>
                        
                        GitHub
                    </a>
                </li>
                
            </ul>
        </div>
    </div>
</div>

        <div class="container">
            <div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
    <ul class="nav bs-sidenav">
    
        <li class="main active"><a href="#groups">Groups</a></li>
        
            <li><a href="#usage">Usage</a></li>
        
            <li><a href="#attributes">Attributes</a></li>
        
            <li><a href="#api">API</a></li>
        
    
    </ul>
</div></div>
            <div class="col-md-9" role="main">

<h1 id="groups">Groups</h1>
<p>Groups tasks into a single row based on defined hierarchy. See <a href="../tree#model">Tree Plugin</a> to define this tree hierarchy.</p>
<h2 id="usage">Usage</h2>
<pre><code>angular.module('myApp', ['gantt', 'gantt.groups']);
</code></pre>
<!-- -->

<pre><code>&lt;div gantt&gt;
  &lt;gantt-groups enabled="..." display="..."&gt;
  &lt;/gantt-groups&gt;
&lt;/div&gt;
</code></pre>
<h2 id="attributes">Attributes</h2>
<ul>
<li>
<h4 id="enabled">enabled</h4>
<p>Enable display of groups.</p>
<p>default: <code>true</code></p>
</li>
<li>
<h4 id="display">display</h4>
<p>Display mode of groups.</p>
<ul>
<li><code>group</code>: Display a single object representing the grouped task.</li>
<li><code>overview</code>: Display a minimized overview of each grouped task.</li>
<li><code>promote</code>: Move each grouped task to parent row on row collapse.</li>
</ul>
<p>default: <code>group</code></p>
</li>
</ul>
<p>Attributes can be defined for a specific <code>Row</code> or <code>Task</code> object using an object property named <code>groups</code></p>
<pre><code>{
  ...
  // Inside Row or Task object
  // Full options object
  'groups': {
    'enabled': &lt;Boolean&gt;,
    'display': '...',
    'from': '&lt;Date&gt;', // force from date to this value
    'to': '&lt;Date&gt;' // force to date to this value
  }

  // Or shortcut for enabled property
  'groups': &lt;Boolean&gt;
}
</code></pre>
<h2 id="api">API</h2>
<h3 id="methods">Methods</h3>
<ul>
<li>
<p><strong>api.groups.refresh()</strong></p>
<p>Refresh hierarchy of groups based on model.</p>
</li>
</ul>
</div>
        </div>

        

        <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
        <script src="../../js/bootstrap-3.0.3.min.js"></script>
        <script src="../../js/prettify-1.0.min.js"></script>
        <script src="../../js/base.js"></script>
        <script src="../../skeletons/plugin.js"></script>
    </body>
</html>